home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / icon tools / addinfo / addinfo.doc < prev    next >
Text File  |  1996-04-07  |  6KB  |  191 lines
  1. AddInfo v1.4
  2.  
  3. AddInfo and this documentation are Copyright © 1994 by Michael Barsoom.
  4.  
  5. -+- License  -+-
  6.  
  7. AddInfo may be freely distributed as long as no charge is made other
  8. than to cover time and copying costs.  This should be no higher than what
  9. Fred Fish charges from one of his freely redistributable disks.
  10.  
  11. You may not copy and/or distribute this program without the accompanying
  12. documentation unless you get permission from the author to do so.
  13.  
  14. Fred Fish and Walnut Creek have permission to include this program on their
  15. FD disks/CDRoms.
  16.  
  17. Finally if you wish to include AddInfo on a disk magazine you are REQUIRED
  18. to get the author's permission FIRST.  Usually this will require you to
  19. just send me a copy of the issue with AddInfo free of charge.
  20.  
  21. -+- Disclaimer -+-
  22.  
  23. This product is sold "as is" without representation or warranty of
  24. any kind, either expressed or implied. The user assumes all risks and
  25. responsibilities related to its use.
  26.  
  27. -+- Introduction -+-
  28.  
  29. AddInfo will automatically add icons to files that dont have them.  It does
  30. this by examining the file, determining the filetype and adding the icon
  31. you have specified for that type in the config file.  By default AddInfo
  32. will not replace existing icons, and will 'float' the icon position in the
  33. new icons; but both options can be changed by cli keywords/tooltypes.  If
  34. AddInfo cannot find the file type in the prefs file, you can use a
  35. filerequester to choose the icon you which to add.  AddInfo is also fully
  36. localized, do it can be run in any language.  Included is AddInfoPrefs, a
  37. GUI to quickly and easily edit AddInfo prefs file.
  38.  
  39. -+- Requirements -+-
  40.  
  41. 1) Workbench 2.0+
  42. 2) ReqTools library v38+  (© Nico Francois) Not Included
  43. 3) WhatIs library         (© Sylvain Rougier & Pierre Carette)   Included
  44.  
  45. -+- Optional -+-
  46.  
  47. If you use the NewIcon package by Nicola Salmoria, AddInfo will not destroy
  48. the palette information when it adds icons to files.
  49.  
  50. -+- Installation -+-
  51.  
  52. 1) Put AddInfo where ever you want
  53. 2) Modify the prefs file to your system and save it in either ENV: or S:
  54.    NOTE:  If you want to use AddInfoPrefs to modify the supplied prefs
  55.           file, first copy it to S: or ENV: so that it can find it.
  56. 3) Make sure you have reqtools and WhatIt libraries installed.
  57.    NOTE: WhatIs library is included, please see its documentation on
  58.          how to set it up.
  59.  
  60. -+- Usage -+-
  61.  
  62. From CLI.
  63.  
  64. AddInfo File/M/A,NoFloat/S,Quiet/S,Force/S:
  65.  
  66. <File>   name of files to add icons to
  67. NoFloat  don't 'float' the position of new icons
  68. Quiet    suppress all error messages
  69. Force    add the icon, even if one exists
  70.  
  71. NOTE:  if quiet is selected you will not be presented with the file
  72. requester if the file type is not found in the prefs file
  73.  
  74. From WorkBench
  75.  
  76. You can specify the following tooltypes,
  77.     NoFloat \
  78.     Quiet    } see above for a description
  79.     Force   /
  80.  
  81. You just extend select the files you wish to add icons to.
  82.  
  83. -+- Prefs File format -+-
  84.  
  85. <cut>
  86. ; Template TYPE/A,ICON/A/F
  87. ; Type = WhatIs file type
  88. ; Icon = Full path of icon to use for that type
  89. ;        with or without the .info
  90. c sc:icons/def_c
  91. <cut>
  92.  
  93. The above is an example of the prefs file.  Each line is a different
  94. config.  The first argument should be the filetype, the second the full
  95. path of the icon to use with that type without the .info.  If the filetype
  96. contains spaces be sure to enclose them in quotes.
  97.  
  98. The prefs file can be saved in ENV:  or in S:  AddInfo will look in ENV:
  99. first however.
  100.  
  101. -+- AddInfoPrefs -+-
  102.  
  103. AddInfoPrefs is a gui editor to quickly edit your prefs.  AddInfoPrefs when
  104. run will present you with a list of all filetypes that your system
  105. currently recognizes (these include those built into WhatIt.library and the
  106. ones you've setup in the S:FileTypes).  Under this list is a string gadget.
  107. This gadget will show the name of the icon (without the .info) that AddInfo
  108. will give the highlighted filetype.  You can select the icon in one of
  109. three ways.  1) just type it in the string gadget 2) click on 'Get' and use
  110. the file requester to pick the icon or 3) just drop the icon on the window
  111. and AddInfoPrefs will automatically change the current icon to the one you
  112. dropped.
  113.  
  114. The other three buttons are self explanatory.
  115.  
  116. There are two versions of AddInfoPrefs. The one without the letter 'm' uses
  117. gadtools for its GUI, and the one with the letter 'm' use MUI for its gui.
  118. However they two version work exactly the same.
  119.  
  120. -+- Shareware -+-
  121.  
  122. Please support the shareware concept.
  123.  
  124. AddInfo is shareware, if you use it regularly you are asked to pay
  125. the shareware fee of $5 US.
  126.  
  127. -+- Thanks -+-
  128.  
  129. To my loving wife Barbara.
  130.  
  131. -+- Bugs, Suggestions -+-
  132.  
  133. you can reach me at:
  134.  
  135. 5524 Pine Street
  136. Omaha NE 68106
  137. USA
  138.  
  139. Internet:  mbars@bluejay.creighton.edu
  140.  
  141. -+- History -+-
  142. AddInfo
  143.  
  144. v1.0
  145.  o First release
  146.  
  147. v1.1
  148.  o Would not open addinfo.catalog if it existed. (fixed)
  149.  o If you specified a dir as 'name/' on the cli, addinfo would not
  150.    add the icon, but rather make a .info file in the directory (fixed)
  151.  o Include MagicWorkbench style icons, thank to Niels Jørgensen
  152.    for send them to me.
  153.  
  154. v1.2
  155.  o Includes whatis.library v4.2
  156.  o Forgot to close the Locale.library and the catalog (fixed)
  157.  o Made executable shorter
  158.  o Added some more error checking, NOTE: Catalog has changed slightly.
  159.  
  160. v1.3
  161.  o If file already has an icon you will be asked if you want to replace it
  162.  
  163. v1.4
  164.  o Icons can not be specified in the prefs file with or without the .info
  165.  o Full support for NewIcons added.
  166.  o Added 'abort' to requesters.
  167.  o Added Norsk (Norwegian) catalog, thanks to Øyvind Falch
  168.  
  169.  
  170. AddInfoPrefs
  171.  
  172. v1.0
  173.  o First release
  174.  
  175. v1.1
  176.  o Reload gadget is disabled untill config is changed.
  177.  o It would not think that the config was changed if you changed
  178.    it using the appwindow (fixed)
  179.  
  180. v1.2
  181.  o Some memory was not being returned after exiting (fixed)
  182.  o Now uses file image instead for get gadget.
  183.  
  184. v1.3
  185.  o Some minor fixes in the code.
  186.  
  187. v1.4
  188.  o Now if there is already an icon name specified, the filerequester will 
  189.    default to that icon
  190.  o Now longer requires reqtools, it will now use the built in asl file
  191.    requester which is part of the mui package.